﻿#region Copyright(C) 2010-2012 FI Ltd. All rights reserved.
// ==================================================================================================
// Copyright(C) 2018 FI Ltd. All rights reserved.
//
// SYSTEM NAME	    : FI.Net Application Framework
// COMPONENT ID	    : FI.Core.StringResource.RecordState
// COMPONENT DESC   : 
//
// CREATED DATE/BY  : 18 Aug 2018 / Tian Mi
//
// REVISION HISTORY : 
// DATE/BY			SR#/CS/PM#/OTHERS		DESCRIPTION OF CHANGE
// ==================================================================================================
#endregion

namespace FI.Core.StringResource
{
    /// <summary>
    /// Record State
    /// <list type="table">
    ///     <listheader>
    ///         <term>Record State</term>
    ///         <description>Comments</description>
    ///     </listheader>
    ///     <item>
    ///         <term>Detached</term>
    ///         <description>StringRecord is created but not added to StringRecordSet.</description>
    ///     </item>
    ///     <item>
    ///         <term>Unchanged</term>
    ///         <description>StringRecord is added to StringRecordSet, and all changes are accepted.</description>
    ///     </item>
    ///     <item>
    ///         <term>Added</term>
    ///         <description>StringRecord is created and added to StringRecordSet</description>
    ///     </item>
    ///     <item>
    ///         <term>Deleted</term>
    ///         <description>StringRecord is removed from StringRecordSet</description>
    ///     </item>
    ///     <item>
    ///         <term>Modified</term>
    ///         <description>StringRecord is modified when in StringRecordSet, the previous status must be Unchanged or Modified</description>
    ///     </item>
    /// </list>
    /// </summary>
    public enum RecordState
    {
        /// <summary>
        /// Detached
        /// </summary>
        Detached = 0,
        /// <summary>
        /// Unchanged
        /// </summary>
        Unchanged = 1,
        /// <summary>
        /// Added
        /// </summary>
        Added = 2,
        /// <summary>
        /// Deleted
        /// </summary>
        Deleted = 3,
        /// <summary>
        /// Modified
        /// </summary>
        Modified = 4
    }
}
